home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 007a / fdanlz.zip / FDANLZ.DOC < prev    next >
Text File  |  1991-04-22  |  7KB  |  225 lines
  1.                 FDANLZ Version 1.20 SYSOP Documentation
  2.                    Copyright 1991    Sanft Consulting
  3.  
  4.  
  5. FDANLZ is written for use with Frontdoor(c) style usage logs.
  6. I use FroDo, but could never find a log analyzer I liked
  7. well enough, so I sat down and wrote this one.  With some help from
  8. five or so Sysops here it is: FDANLZ.
  9.  
  10.  
  11.  
  12.   Purpose
  13. ===========
  14.  
  15. I wrote this for a few specific reasons.
  16.  
  17.     1) I want to log everything that happens with FroDo, but unless
  18.        I am looking for something in particular, I do not want to 
  19.        browse the entire file every day.
  20.  
  21.     2) I wanted a separate file to show all Fatal FroDo errors and
  22.        another file to show all Transmissions.
  23.     
  24.     3) I did not like to keep adding to the current log file, making it even
  25.        harder to keep track of goings on.
  26.  
  27.     4) I did not like to keep these huge log files on disk if I did not
  28.        need them.  I needed a way to ZIP them up.        
  29.     
  30. o FDANLZ takes your current FroDo log file and creates the same file in your
  31.   target directory, only it will change the name to FDLOG with an extension
  32.   of day of year just like nodelists.  
  33.  
  34. o Optionally, it will write all fatal errors to a file called FDFATAL.ERR and 
  35.   all transmission information into a file called FDTRANS with an extention of
  36.   day of year.  
  37.  
  38. o When it is all done it will deleted your old log file (optionally).
  39.  
  40. o It will also ZIP your log file for the day to save space (optionally).
  41.  
  42.  
  43.   Usage
  44. ==========
  45.  
  46. This program can be run on any FroDo style log and is very configurable.
  47.  
  48.  
  49.  SETUP
  50. =======
  51.  
  52. FDANLZ comes with 3 files:
  53.  
  54. FDANLZ.DOC       This Document
  55.  
  56. FDANLZ.EXE       Main Program
  57.  
  58. FDANLZ.CFG       System Information (See below)
  59.  
  60.  
  61.  The FDANLZ.CFG file
  62. =====================
  63.  
  64. This file is a 6-line file that holds the following information:
  65.  
  66. Line #1 : Complete path and file name to your FroDo log file.
  67.  
  68. Line #2 : Add all Fatal errors to FDFATAL.ERR. (Y or N)
  69.  
  70. Line #3 : Write File Transmission info to FDTRANS.(Day_of_year).  
  71.  
  72. Line #4 : Delete your FroDo log file when Done. 
  73.  
  74. Line #5 : Zip FDLOG.(day_of_year) to FDLOGZ.(day_of_year) and delete FDLOG.(doy)
  75.  
  76. Line #6 : Output path where you want all output files.
  77.  
  78.  
  79. Example:
  80.  
  81. C:\FD\FD.LOG                           :Complete path and file name of log file
  82. Y                                      :Write FATAL errors file  (Y or N)
  83. Y                                      :Write Transmission info  (Y or N)
  84. Y                                      :Delete your log file when done (Y or N)
  85. N                                      :Zip log file for current day (Y or N)
  86. C:\HOLDLOG\                            :Path for output files.
  87.  
  88.  
  89.  Installation
  90. ==============
  91.  
  92. This is really hard:
  93.  
  94. 1) Set up your FDANLZ.CFG file to your taste.  
  95. 2) Add FDANLZ.EXE to your midnight event.  
  96. 3) Make sure FDANLZ.EXE and FDANLZ.CFG are in same directory.
  97.  
  98. That is about it.
  99.  
  100.  
  101.  
  102.  
  103.  Status Screen
  104. ===============
  105.  
  106. When you execute FDANLZ, it will give you a Sysop status screen of what 
  107. your selected configuration is.  
  108.  
  109. Example screen :
  110.  
  111.  
  112. FDANLZ 1.20 FroDo analyzer,  (c)1991  Sanft Consulting
  113.                                       FidoNet 1:282/83
  114.  
  115. Options selected:
  116.  
  117. Copying {your_log_file} to {path} FDLOG.{Day_of_year}
  118. Writing Fatal Errors to {path} FDFATAL.ERR                       (If selected)
  119. Writing Transmission information to {path} FDTRANS.{Day_of_year} (If selected)
  120. Deleting (your_log_file)                                         (If selected)
  121. Zipping FDLOG.{Day_of_year} to FDLOGZ.{Day_of_year}              (If selected)
  122.  
  123.  
  124. This screen is informative and helpful for Debugging.  If you are not sure if 
  125. you are passing parameters correctly, simply put a PAUSE in the .BAT file 
  126. running FDANLZ right after FDANLZ is called.  It will let you look at the 
  127. information and make sure everything is configured correctly.
  128.  
  129.  
  130.  Special Considerations
  131. ========================
  132.  
  133. The EXE and CFG file must be in the same and current directory.
  134.  
  135. PKZIP(c) must be in your path if you have selected file ziping.
  136.  
  137. Thanks to improved error handling, this program should never freeze because
  138. of an unrecoverable error.  It should exit normally.
  139.  
  140. You probably want to configure FroDo to log most or all informational messages.
  141.  
  142.  
  143.  Registration
  144. ==============
  145.  
  146. FDANLZ is released into Shareware.  As you are probably a fellow Sysop if
  147. you have gotten this far, you understand the need for the Shareware concept!
  148. Please support Shareware concept (and me!). If you use this package for longer
  149. then 30 days please send $8 dollars to:
  150.  
  151.             Sanft Consulting
  152.         C/O Magical Mystery BBS
  153.             P.O. Box 7062
  154.             St. Paul, MN  55107
  155.  
  156. This program is not crippled in any way.  It does not beep, bleep, delete 
  157. itself etc.  
  158.  
  159.  
  160.  
  161.  Validation
  162. ============
  163.  
  164. This program was compiled on 04-21-91. The size is 42,402
  165.  
  166. Running  Validate v0.3  (c)1989-1990  McAfee Associates:
  167.  
  168.           File Name: FDANLZ.EXE
  169.                Size: 45,402
  170.                Date: 04-21-1991
  171.  
  172. File Authentication:
  173.      Check Method 1 - 44ED
  174.      Check Method 2 - 0F72
  175.  
  176.  
  177.  Warranty
  178. ==========
  179.  
  180. This software package and accompanying documentation are provided
  181. "AS IS", without warranty of any kind.  The entire risk as to the 
  182. results of using this program is assumed by you.
  183.  
  184.  
  185.  
  186.  Credits
  187. =========
  188.  
  189. A special thanks to Stan Hirschman, (1:282/40) who blew an entire Sunday coming
  190. up with help making what I think is a very clean, helpful program.
  191.  
  192. Frontdoor(c) is copyrighted by Joaquim H. Homrighausen (Thanks JoHo!)
  193. PKZIP(c) is copyrighted by PKWARE Inc.
  194. Quickbasic(c); MS-DOS(c) are copyrighted by MicroSoft Corporation.
  195. Validate v0.3 is copyrighted by McAfee Associates. 
  196.  
  197.  Changes
  198. =========
  199.  
  200. 1.00  04-20-91  FDANLZ written, released for BETA testing.
  201.  
  202. 1.10  04-21-91  Changed FDANLZ.SYS to FDANLZ.CFG.  
  203.                 Added the option to ZIP current days log for space saving.              
  204.                 Added extract of $ entries into FDTRANS.
  205.                 Spell checked this document (Oppppss!)
  206.  
  207. 1.20  04-22-91  Put final touches on documentation.
  208.                 Added comments to FDANLZ.CFG.
  209.                 Cleaned up status screen.
  210.                 Released to general public.
  211.                 
  212.  
  213.  
  214.  
  215.  Epilogue
  216. ==========
  217.  
  218. Any questions or problems?  Need a program?
  219.  
  220. E-mail me (Ted Sanft) on Magical Mystery BBS (612)552-1631 or
  221. Ted Sanft @FIDONET (1:282/83).
  222.  
  223. I hope you like this package, and if you have any good ideas for it, 
  224. let me hear them...
  225.